chore: cleaning + major versions upgrade by SRWieZ · Pull Request #147 · NativePHP/electron

SRWieZ · 2024-12-21T18:55:01Z

Summary of changes

Removed old vue dependencies
Removed stall files in dist/ from previous plugin builds (added rimraf before building plugin)
Fixed some type return in window.ts
Major version upgrade npm outdated:
- vite v4 to v5
- typescript v4 to v5
- stylelint v14 to v16
- prettier v2 to v3
- eslint v8 to v9
- electron-builder v24 to v25
- electron-chromedriver v31 to v32
- electron-context-menu v3 to v4
- get-port v5 to v7
- electron v31 to v32

Every commit is checked with (native:serveand native:build)

✅ (typescript, vite, jest, eslint, electron-chromedriver, prettier) 1f38d64
✅ ESLint upgraded, migrated but not applied 54b83e0
✅ ESM migration: 825c342 245252f
✅ Update of get-port, electron, electron-store and electron-context-menu 84f86e1 bb72311 df6fcbf

Upgrades to the last version of electron and vite blocked by

menubar: chore(deps): update to electron 34.x.x max-mapper/menubar#486
electron-vite: Vite 6 support alex8088/electron-vite#673

About the ESM upgrade:
More and more packages becomes ESM only. Electron supports ESM since v28. Here is some links to read for a better understanding:

Pure ESM package: https://github.com/sindresorhus/electron-store/releases/tag/v9.0.0
Pure ESM Package: https://github.com/sindresorhus/get-port/releases/tag/v6.0.0
Pure ESM Package: https://github.com/sindresorhus/electron-context-menu/releases/tag/v4.0.0
Gist explaining the steps to migrate and why it became a nightmare to maintain two versions of the same library. https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
TypeScript and ESM: https://www.typescriptlang.org/docs/handbook/modules/reference.html
Electron ESM support: https://www.electronjs.org/docs/latest/tutorial/esm
Jest ESM support: https://jestjs.io/docs/ecmascript-modules
Electron Vite support: https://electron-vite.org/guide/dev#migrating-to-esm

SRWieZ · 2024-12-21T19:16:58Z

WIP. Current state of npm outdated

Before & after

SRWieZ · 2024-12-22T22:41:49Z

Finished and ready to be tested ! 🎉

With this PR, we are up to date! We are only one version behind Electron and Vite.

I tested this PR with many of my apps without any problem.

There is one small irony:
The Jest tests I fixed here #148 are now broken.

I tried every other tutorial on the internet, and I don't understand why it doesn't mock electron. But to be fair, the tests haven't been working for a long time and are not testing the app fairly enough.

My suggestion is to migrate to vitest, which supports ESM modules out of the box and has a compatible syntax (it, test, describe, etc...). Maybe even make tests with electron rendered?

Post scriptum:
Intel Mac users, you may notice the following error in your console, which can be ignored:
EGL Driver message (Error) eglQueryDeviceAttribEXT: Bad attribute. electron/electron#43415
The solution is to either wait or disable GPU acceleration. So be patient.

Final result 😎

Happy holidays to everyone! 🎊

SRWieZ · 2024-12-25T16:31:27Z

Hold on to that, I found an error.

SRWieZ · 2024-12-25T19:16:27Z

Fixed!

I didn't pay enough attention to the Electron ESM documentation. preload.js wasn't preloading.

I'm developing all my apps with the "dev-main" requirement, so I noticed this issue in another app where I'm heavily using Livewire events.

SRWieZ · 2024-12-25T22:46:21Z

I missed the build/notarize.js file, which my IDE completely hid from me. 🙄

I don't know why, but I cannot remove this directory from the excluded ones in PhpStorm. I also wonder if I'm the only one facing this issue. If not, we should probably rename this directory.

Anyway, I confirm that I can still build and use my app as before.

simonhamp · 2024-12-26T17:21:22Z

There are some conflicts here which need to be resolved since I've merged #149.

It seems to be mostly around file names.... do we need the .js extensions on the imports now for some reason?

Could you take a look when you get chance?

SRWieZ · 2024-12-26T17:38:05Z

Yes, I can.

Can you merge #148 first? I will have a conflict with it as well.

This PR modifies all files, so the more pull requests you merge beforehand, the easier it will be to resolve conflicts at once.

…int, electron-chromedriver, prettier)

+ get-port v5 to v7 + cleaned some imports

+ update electron context menu

+ update electron-store

+ update deps + cleaning unused imports + more ESM conversion

This reverts commit 3193381.

SRWieZ · 2024-12-26T20:41:27Z

Rebased on main.

The minimum required node version is 20.

Bumped on GitHub Actions
Bumped on package.json

It seems to be mostly around file names.... do we need the .js extensions on the imports now for some reason?

Yes we have to. It's explained here and here

simonhamp · 2024-12-29T13:50:57Z

That failing to run the plugin test suite concerns me...

SRWieZ · 2024-12-29T14:46:29Z

I was planning to look into that after this one is merged.

I don't think I can make it work in jest. It's clearly a module resolution problem, and I have tried every other way before giving up.

I can explore the vitest approach if you want, here or in another PR.

SRWieZ · 2024-12-29T15:53:48Z

Obviously, I don't give up on the testing suite.

As you have seen with my previous PR, I think it's important to have a solid one.

It's just that with jest, I tried lots of different suggestions, and it's already hard to make it work well with TypeScript; it's worth it with ESM.

I really think we have a good chance with vitest if we believe the homepage (and some Stack Overflow users).

From https://vitest.dev:

Vite Powered: Reuse Vite's config and plugins - consistent across your app and tests. But it's not required to use Vitest!
Jest Compatible: Expect, snapshot, coverage, and more - migrating from Jest is straightforward.
Smart & instant watch mode: Only rerun the related changes, just like HMR for tests!
ESM, TypeScript, JSX: Out-of-the-box ESM, TypeScript, and JSX support powered by esbuild.

simonhamp · 2024-12-31T16:01:28Z

I managed to make some progress on getting the test suite running...

The failures seem to be related to the upgrades... maybe Vitest will handle all of this a little better, I don't know...

I'm going to approve this for now as I've been able to manually validate that things are still working (tho I suspect there may be some gremlins hidden away) and we can explore Vitest in a separate PR, and another one with my "fixes" for this test suite

SRWieZ · 2024-12-31T16:28:05Z

Cool! 🎉

We'll find the gremlins before tagging.

I'm going to pass all my apps to require "dev-main"

I tried the node --experimental-require-module node_modules/jest/bin/jest.js way too without success.

That would be included in node23 by the way.

Also this mode broke PHPStorm tests. I'm sure it's just a matter of configuring the experimental mode but it's better for contributors if it just work out of the box.

SRWieZ · 2025-01-22T18:35:53Z

electron-vite has tagged 3.0-beta, which supports Vite v6 & Electron <= 34

https://github.com/alex8088/electron-vite/releases/tag/v3.0.0-beta.0

SRWieZ mentioned this pull request Dec 22, 2024

fix: all test suites #148

Merged

SRWieZ marked this pull request as ready for review December 22, 2024 22:12

SRWieZ mentioned this pull request Dec 23, 2024

feat: can analyse package-lock.json in a subdirectory whatsdiff/whatsdiff#6

Merged

SRWieZ marked this pull request as draft December 25, 2024 16:31

SRWieZ marked this pull request as ready for review December 25, 2024 19:16

SRWieZ added 11 commits December 26, 2024 19:13

chore: cleaning + major versions upgrade (typescript, vite, jest, esl…

2d1b4d4

…int, electron-chromedriver, prettier)

chore: converted to ESM imports

fb1d9fc

+ get-port v5 to v7 + cleaned some imports

fix: better ESM __dirname

11ca8ee

fix: eslint migrate from .eslintrc to eslint.config.js

ee43c7f

wip: jest typescript esm

ea5e845

+ update electron context menu

wip: jest typescript esm

df36906

+ update electron-store

wip: jest electron mock

289f0db

chore: upgrade electron to v32

08feb8b

fix: preload has to end with .mjs in ESM mode

900d57b

+ update deps + cleaning unused imports + more ESM conversion

fix: convert notarize.js to ESM modules

52b59c8

fix: rebased on main

e8fc6fa

SRWieZ force-pushed the chore-update-major-deps branch from 0ab24c9 to e8fc6fa Compare December 26, 2024 19:31

SRWieZ added 4 commits December 26, 2024 20:48

wip: why??

3193381

fix: node v20 minimum dependency

80e6b1f

Revert "wip: why??"

c8e4d1f

This reverts commit 3193381.

fix: node v20 minimum dependency

faaf912

simonhamp approved these changes Dec 31, 2024

View reviewed changes

simonhamp merged commit 9c9d369 into NativePHP:main Dec 31, 2024

Uh oh!

Conversation

SRWieZ commented Dec 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SRWieZ commented Dec 21, 2024

Uh oh!

SRWieZ commented Dec 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SRWieZ commented Dec 25, 2024

Uh oh!

SRWieZ commented Dec 25, 2024

Uh oh!

SRWieZ commented Dec 25, 2024

Uh oh!

simonhamp commented Dec 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SRWieZ commented Dec 26, 2024

Uh oh!

SRWieZ commented Dec 26, 2024

Uh oh!

simonhamp commented Dec 29, 2024

Uh oh!

SRWieZ commented Dec 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SRWieZ commented Dec 29, 2024

Uh oh!

simonhamp commented Dec 31, 2024

Uh oh!

SRWieZ commented Dec 31, 2024

Uh oh!

SRWieZ commented Jan 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

SRWieZ commented Dec 21, 2024 •

edited

Loading

SRWieZ commented Dec 22, 2024 •

edited

Loading

simonhamp commented Dec 26, 2024 •

edited

Loading

SRWieZ commented Dec 29, 2024 •

edited

Loading